Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MQTT climate preset_modes rework #66062

Merged
merged 4 commits into from
Feb 17, 2022

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Feb 8, 2022

Breaking change

hold and away mode config settings will be deprecated and removed with release 2022.9. This will break existing integrations that make use of these config settings. Integrations should use the new preset_mode configuration options.

Proposed change

This PR simplifies the use of preset_modes with the MQTT climate platform.
This is a follow up on https://developers.home-assistant.io/blog/2019/07/03/climate-cleanup/.
It will introduce a preset_mode_command_topic, preset_mode_command_template, preset_mode_state_topic and preset_mode_value_template to replace the current hold and away mode settings.

The following configuration settings will be deprecated:

  • away_mode_command_topic
  • away_mode_state_topic
  • away_mode_state_template
  • hold_mode_command_topic
  • hold_mode_command_template
  • hold_mode_state_topic
  • hold_mode_state_template
  • hold_mode_state_template
  • hold_modes

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link

Hey there @emontnemery, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great cleanup, thanks @jbouwh 👍

Let's extend the deprecation period to 6 months though, so 2022.9
We should consider bumping removal of CONF_SEND_IF_OFF to the same release so there's only one planned release where we break MQTT climate.

homeassistant/components/mqtt/climate.py Show resolved Hide resolved
@jbouwh jbouwh force-pushed the mqtt-climate-preset_modes branch from dfd678a to f9a619a Compare February 10, 2022 14:12
@jbouwh
Copy link
Contributor Author

jbouwh commented Feb 10, 2022

Great cleanup, thanks @jbouwh 👍

Let's extend the deprecation period to 6 months though, so 2022.9 We should consider bumping removal of CONF_SEND_IF_OFF to the same release so there's only one planned release where we break MQTT climate.

Updated the deprecation comments to 2022.9

Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @jbouwh 👍

@emontnemery emontnemery merged commit 83846bb into home-assistant:dev Feb 17, 2022
@jbouwh jbouwh deleted the mqtt-climate-preset_modes branch February 17, 2022 12:52
@github-actions github-actions bot locked and limited conversation to collaborators Feb 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants